mock-property

mock-property

Given an object and a property, replaces a property descriptor (or deletes it), and returns a thunk to restore it.

Example

var mockProperty = require('mock-property');
var assert = require('assert');

var i = 0;
var object = {
	a: 1,
	get b() {
		i += 1;
		return 'b ' + i;
	}
};

assert.equal(object.a, 1);
assert.equal(object.b, 'b 1');
assert.equal(object.b, 'b 2');

var restoreA = mockProperty(object, 'a', { 'delete': true });
assert.equal('a' in object, false);

var restoreB = mockProperty(object, 'b', { value: 42 });
assert.equal(object.b, 42);

restoreA();
assert.equal('a' in object, true);

restoreB();
assert.equal(object.b, 'b 3');

Tests

Simply clone the repo, npm install, and run npm test

Security

Please email @ljharb or see https://tidelift.com/security if you have a potential security vulnerability to report.

Changelog

v1.1.0 - 2024-08-06

Commits

• [Tests] refactor tests for easier testing of multiple properties 605c32e
• [New] add types 848be58
• [Fix] properly stringify Symbol properties 369d824
• [Fix] avoid a crash when mocking a nonexistent data property as non-enumerable sans a value 9994626
• [Dev Deps] update @ljharb/eslint-config, aud, npmignore, object-inspect, tape ebfaf9a
• [Dev Deps] ensure tape’s mock-property is ourself, for testing 2deaf72
• [Deps] update define-data-property, has-property-descriptors, hasown e9f503d
• [Tests] switch from aud to npm audit f5e6ce2
• [meta] add sideEffects flag 2089940